tsparticles-engine
Advanced tools
Easily create highly customizable particle, confetti and fireworks animations and use them as animated backgrounds for your website. Ready to use components available also for React, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Riot.js, Inferno.
A lightweight TypeScript library for creating particles. Dependency free (*), browser ready and compatible with React.js, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Inferno, Riot.js, Solid.js, and Web Components
Documentation and Development references here 📖
This library is available on two of the most popular CDNs and it's easy and ready to use, if you were using particles.js it's even easier.
You'll find the instructions below, with all the links you need, and don't be scared by TypeScript, it's just the source language.
The output files are just JavaScript. 🤩
CDNs and npm have all the sources you need in Javascript, a bundle browser ready (tsparticles.engine.min.js), and
all
files splitted for import syntax.
If you are interested there are some simple instructions just below to guide you to migrate from the old particles.js library.
Please use these hosts or your own to load tsParticles on your projects
https://unpkg.com/tsparticles-confetti/ https://unpkg.com/tsparticles-engine/ https://unpkg.com/tsparticles-fireworks/ https://unpkg.com/tsparticles-basic/ https://unpkg.com/tsparticles-slim/ https://unpkg.com/tsparticles/ https://unpkg.com/tsparticles-all/
tsParticles Confetti
tsParticles Engine
tsParticles Fireworks
tsParticles Basic
tsParticles Slim
tsParticles
tsParticles All
npm install tsparticles-engine
yarn add tsparticles-engine
pnpm install tsparticles-engine
const tsParticles = require("tsparticles-engine");
// or
import { tsParticles } from "tsparticles-engine";
The imported tsParticles is the same instance you have when including the script in the page using the <script> tag.
Load tsParticles and configure the particles:
index.html
<div id="tsparticles"></div>
<script src="tsparticles.engine.min.js"></script>
app.js
// @path-json can be an object or an array, the first will be loaded directly, and the object from the array will be randomly selected
/* tsParticles.load(@params); */
tsParticles
.load({
id: "tsparticles",
url: "presets/default.json",
})
.then((container) => {
console.log("callback - tsparticles config loaded");
})
.catch((error) => {
console.error(error);
});
//or
tsParticles.load({
id: "tsparticles",
options: {
/* options here */
},
});
//or
tsParticles.load({
id: "tsparticles",
options: [
{
/* options here */
},
{
/* other options here */
},
],
});
//random object
tsParticles.load({
id: "tsparticles",
options: [
{
/* options here */
},
{
/* other options here */
},
],
index: 1,
}); //the second one
// Important! If the index is not in range 0...<array.length, the index will be ignored.
// after initialization this can be used.
/* tsParticles.setOnClickHandler(@callback); */
/* this will be fired from all particles loaded */
tsParticles.setOnClickHandler((event, particles) => {
/* custom on click handler */
});
// now you can control the animations too, it's possible to pause and resume the animations
// these methods don't change the config so you're safe with all your configurations
// domItem(0) returns the first tsParticles instance loaded in the dom
const particles = tsParticles.domItem(0);
// play will start the animations, if the move is not enabled it won't enable it, it just updates the frame
particles.play();
// pause will stop the animations
particles.pause();
ng-particles
Instructions available here
astro-particles
Instructions available here
ember-tsparticles
Instructions available here
inferno-particles
Instructions available here
jquery-particles
Instructions available here
preact-particles
Instructions available here
react-particles
Instructions available here
riot-particles
You can find the instructions here
solid-particles
You can find the instructions here
svelte-particles
Instructions available here
vue2-particles
Instructions available here
vue3-particles
Instruction available here
web-particles
You can find the instructions here
wordpress-particles
The plugin page hosted on WordPress.org can be found here
Actually, an official tsParticles plugin isn't existing, but I have a collaboration with
the Premium Addons for Elementor plugin collection.
There are some presets ready to be used in this repository, and they also have a bundle file that contains everything needed to run.
This preset loads big colored circles moving upwards on a white background.
You can find the instructions here
This preset loads colored bubbles coming from the bottom of the screen on a white background.
You can find the instructions here
This preset loads white and red confetti launched from the screen center on a transparent background.
You can find the instructions here
This preset loads a faded red to a black background with particles colored like fire and ash sparks.
You can find the instructions here
This preset loads a mouse trail made with small fading particles like little fireflies.
You can find the instructions here
This preset loads a beautiful fireworks effect.
You can find the instructions here
You can find the instructions here
You can find the instructions here
You can find the instructions here
You can find the instructions here
You can find the instructions here
You can find the instructions here
You can find some tsParticles related templates here. The templates are created for Vanilla Javascript, ReactJS, VueJS, Angular, SvelteJS, and other frameworks.
The templates will vary, new ones can be created or older ones updated with the latest features or changed to a better style. Check them out once in a while.
If you created some good design with tsParticles feel free to submit a pull request with your cool template, you'll be credited as the template author!
https://github.com/tsparticles/templates
https://particles.js.org/samples
You can find all video tutorials on the website here: https://particles.js.org/video.html
More videos are coming soon! Check every day if there are some new contents.
particles.json
You can find some config samples here 📖
You can find all options available here 📖
I've created a tsParticles collection on CodePen 😮 or you can check out my profile
Otherwise, there's the demo page link below.
Want to see even more demos? Clone the repository on your computer and follow these instructions
$ pnpm i
$ pnpm run build
$ cd demo/vanilla
$ pnpm start
Boom! 💥 http://localhost:3000 and you can check out other demos.
If you are brave enough you can switch to the dev branch for trying the features under development.
tsParticles has a package that makes this library 100% compatible with the particles.js configuration.
Seriously, you just need to change the script from particles.js to the bundled compatibility package, et-voilà, you're ready 🧙!
You can read more here
Want to know 5 reasons to do the switch? Read here
Below you can find all the information you need to install tsParticles and its new syntax.
tsParticles now supports some customizations 🥳.
You can create your own plugins
Read more here...
flowchart LR
subgraph b [Bundles]
bb[tsParticles Basic] --> bs[tsParticles Slim]
bp[Particles.js compatibility bundle] --> bs
bs --> bf[tsParticles]
end
e[tsParticles Engine] --> b
iea & iebo & iebu & iec & ieg & iepa & iepu & ierem & ierep & ies --> bs
ipa & ipc & ipl --> bs
mb --> bb
mp --> bs
pleq --> bs
sci --> bb
si & sl & spo & ssq & sst & st --> bs
uc & uop & uou & usi --> bb
ul & urot & ust --> bs
iet --> bf
pla & plem --> bf
urol & uti & utw & uw --> bf
subgraph i [Interactions]
subgraph ie [Externals]
iea[Attract]
iebo[Bounce]
iebu[Bubble]
iec[Connect]
ieg[Grab]
iepa[Pause]
iepu[Push]
ierem[Remove]
ierep[Repulse]
ies[Slow]
iet[Trail]
end
il[Light]
subgraph ip [Particles]
ipa[Attract]
ipc[Collisions]
ipl[Links]
ipr[Repulse]
end
end
i --> ie
i --> ip
e --> i
subgraph m [Movers]
mb[Base]
mp[Parallax]
end
e --> m
subgraph pa [Paths]
pac[Curves]
papn[Perlin Noise]
pap[Polygon]
pasn[Simplex Noise]
pasvg[SVG]
end
e --> pa
subgraph pl [Plugins]
pla[Absorbers]
plcm[Canvas Mask]
plem[Emitters]
plh[HSV Color]
pli[Infection]
plm[Motion]
plp[Polygon Mask]
pls[Sounds]
subgraph plea [Easings]
pleb[Back]
pleci[Circ]
plecu[Cubic]
plee[Expo]
pleq[Quad]
ple4[Quart]
ple5[Quint]
ples[Sine]
end
subgraph plex [Exports]
plexi[Image]
plexj[JSON]
plexv[Video]
end
end
pl --> plea
e --> pl
subgraph s [Shapes]
sa[Arrow]
sb[Bubble]
sci[Circle]
scog[Cog]
sh[Heart]
si[Image]
sl[Line]
smt[Multiline Text]
spa[Path]
spo[Polygon]
srp[Rounded Polygon]
srr[Rounded Rectangle]
ssp[Spiral]
ssq[Square]
sst[Star]
st[Text]
end
e --> s
subgraph u [Updaters]
uc[Color]
ud[Destroy]
ug[Gradient]
ul[Life]
uop[Opacity]
uor[Orbit]
uou[Out Modes]
urol[Roll]
urot[Rotate]
usi[Size]
ust[Stroke Color]
uti[Tilt]
utw[Twinkle]
uw[Wobble]
end
e --> u
Huge thanks to ScribbleMaps for their support on this project.
Huge thanks to JetBrains for the 2020-2022 Open Source Licenses!
JetBrains WebStorm is used to maintain this project.
2.12.0 (2023-08-03)
FAQs
Easily create highly customizable particle, confetti and fireworks animations and use them as animated backgrounds for your website. Ready to use components available also for React, Vue.js (2.x and 3.x), Angular, Svelte, jQuery, Preact, Riot.js, Inferno.
The npm package tsparticles-engine receives a total of 34,083 weekly downloads. As such, tsparticles-engine popularity was classified as popular.
We found that tsparticles-engine demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.